/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsr;

import java.util.Hashtable;
import java.util.Vector;

import javax.xml.namespace.QName;

import cgl.narada.wsinfra.schemas.wsr.ResponseDocument;


/** A utility class to deal with creation, Retrieval and processing of 
acknowledgements and  Faults 

    @author Sima Patel
    $Date: 2005/03/18 20:23:05 $
    $Revision: 1.3 $
*/

public interface WsrAckOperations {

    /** Retrieves Vector of groupIds for groups with single message those are 
    already acknowledged from response document
    (Retrieves Acknowledgements for Non Sequence Reply from response document */
    public Vector getNonSequenceReplyAcknowledgement
                                            (ResponseDocument responseDocument);
   
    /** Retrieves Vector of groupIds for groups with single message 
    and have Message Processing Failure Fault from response document
    (Retrieves Message Processing Failure Faults for Non Sequence Reply from 
    response document */
    public Vector getNonSequenceReplyMessageProcessingFailureFault
                                            (ResponseDocument responseDocument);
   
    /** Retrieves Hashtable (groupId and fault pair) for groups with 
    single message and have faults other than Message Processing Failure Fault
    from response document. The hashtable contains those groupIds which are
    not for retrasmission. In this case send fault to application 
    along with details of failure*/
    public Hashtable getNonSequenceReplyFault
                                            (ResponseDocument responseDocument);
   
    /** Retrieves Hashtable (groupId and associated acknowledged
    sequence numbers in vector) for groups with multiple messages from 
    response document. Retrieves Sequence Replies acknowledgements*/
    public Hashtable getSequenceRepliesAcknowledgement
                                            (ResponseDocument responseDocument);
   
    /** Retrieves Hashtable(groupId and vector of sequence numbers) for groups 
    with multiple messages and have Message Processing Failure Fault from 
    response document (Retrieves Message Processing Failure Faults for Sequence 
    Reply from response document */
    public Hashtable getSequenceReplyMessageProcessingFailureFault
                                            (ResponseDocument responseDocument);
   
   
    /** Retrieves Hashtable 
    (groupId and Hashtable(sequenceNumber and fault name)) for groups with 
    multiple messages and have faults other than Message Processing Failure 
    Fault from response document.The hashtable contains those groupIds which are
    not for retrasmission. In this case send fault to application 
    along with details of failure*/
    public Hashtable getSequenceReplyFault(ResponseDocument responseDocument);
   
    /** Checks the fault is Message Processing failure */
    public boolean isMessageProcessingFailureFault(QName fault);
    
    /** create ranges from array of sequence Numbers */
    public Hashtable createRanges(long[] seqNums);
   
    /** create ranges from Hashtable (sequence Number and fault or Ack) pair*/
    public Hashtable createRanges(Hashtable seqNumsAndFaults);
    
    /** Retrieve all groupIds from Response Document for which we receive 
    acknowledgements and faults*/
    public String[] getGroupIds(ResponseDocument responseDocument);
}
